<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.5"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>FreeRTOS Addons: cpp_freertos::ConditionVariable Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">FreeRTOS Addons
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.5 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespacecpp__freertos.html">cpp_freertos</a></li><li class="navelem"><a class="el" href="classcpp__freertos_1_1_condition_variable.html">ConditionVariable</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classcpp__freertos_1_1_condition_variable-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">cpp_freertos::ConditionVariable Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="condition__variable_8hpp_source.html">condition_variable.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a37d388bea146c06f2e1341a542096333"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcpp__freertos_1_1_condition_variable.html#a37d388bea146c06f2e1341a542096333">ConditionVariable</a> ()</td></tr>
<tr class="separator:a37d388bea146c06f2e1341a542096333"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1a761e4196ddcfa8ecb32dc598090091"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcpp__freertos_1_1_condition_variable.html#a1a761e4196ddcfa8ecb32dc598090091">Broadcast</a> ()</td></tr>
<tr class="separator:a1a761e4196ddcfa8ecb32dc598090091"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0138363e79628a7d0c0af8ae39e36bb3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcpp__freertos_1_1_condition_variable.html#a0138363e79628a7d0c0af8ae39e36bb3">Signal</a> ()</td></tr>
<tr class="separator:a0138363e79628a7d0c0af8ae39e36bb3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:adbc148eaddd341d7ae4d07c9e9e33bfd"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcpp__freertos_1_1_condition_variable.html#adbc148eaddd341d7ae4d07c9e9e33bfd">Thread</a></td></tr>
<tr class="separator:adbc148eaddd341d7ae4d07c9e9e33bfd"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >Class implementation of condition variable based on FreeRTOS C++ Wrapper classes.</p>
<p >A condition variable isn't really a variable. It's a list of threads.</p>
<p >The design here is that a <a class="el" href="classcpp__freertos_1_1_thread.html">Thread</a> "waits", and a <a class="el" href="classcpp__freertos_1_1_condition_variable.html">ConditionVariable</a> "signals". This affects where the public interfaces reside. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a37d388bea146c06f2e1341a542096333" name="a37d388bea146c06f2e1341a542096333"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a37d388bea146c06f2e1341a542096333">&#9670;&#160;</a></span>ConditionVariable()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ConditionVariable::ConditionVariable </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p >Constructor to create a condition variable. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a1a761e4196ddcfa8ecb32dc598090091" name="a1a761e4196ddcfa8ecb32dc598090091"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1a761e4196ddcfa8ecb32dc598090091">&#9670;&#160;</a></span>Broadcast()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ConditionVariable::Broadcast </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p >Signal all threads waiting on this <a class="el" href="classcpp__freertos_1_1_condition_variable.html">ConditionVariable</a>. </p>

</div>
</div>
<a id="a0138363e79628a7d0c0af8ae39e36bb3" name="a0138363e79628a7d0c0af8ae39e36bb3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0138363e79628a7d0c0af8ae39e36bb3">&#9670;&#160;</a></span>Signal()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ConditionVariable::Signal </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p >Signal a thread waiting on this <a class="el" href="classcpp__freertos_1_1_condition_variable.html">ConditionVariable</a>. Signaling is implemented as FIFO. </p>

</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a id="adbc148eaddd341d7ae4d07c9e9e33bfd" name="adbc148eaddd341d7ae4d07c9e9e33bfd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adbc148eaddd341d7ae4d07c9e9e33bfd">&#9670;&#160;</a></span>Thread</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">friend class <a class="el" href="classcpp__freertos_1_1_thread.html">Thread</a></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p >The <a class="el" href="classcpp__freertos_1_1_thread.html">Thread</a> class and the <a class="el" href="classcpp__freertos_1_1_condition_variable.html">ConditionVariable</a> class are interdependent. If we allow the <a class="el" href="classcpp__freertos_1_1_thread.html">Thread</a> class to access the internals of the <a class="el" href="classcpp__freertos_1_1_condition_variable.html">ConditionVariable</a>, we can reduce the public interface which is a good thing. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/<a class="el" href="condition__variable_8hpp_source.html">condition_variable.hpp</a></li>
<li>src/freertos-addon/c++/ccondition_variable.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5
</small></address>
</body>
</html>
